home *** CD-ROM | disk | FTP | other *** search
/ Aminet 24 / Aminet 24 (1998)(GTI - Schatztruhe)[!][Apr 1998].iso / Aminet / dev / misc / vahunz.readme < prev   
Text File  |  1998-03-07  |  5KB  |  153 lines
  1. Short:    Make source code un-/more readable
  2. Author:   Thomas Aglassinger <agi@giga.or.at>
  3. Uploader: Thomas Aglassinger <agi@giga.or.at>
  4. Type:     dev/misc
  5. Kurz:     Macht Quellcode un-/besser lesbar
  6. Requires: AmigaOS 2.04, 68020, 2MB
  7.  
  8. TITLE
  9.  
  10.   vahunz - Make source code un-/more readable.
  11.  
  12. VERSION 
  13.  
  14.   1.1
  15.  
  16. AUTHOR
  17.  
  18.   Thomas Aglassinger <agi@giga.or.at>
  19.  
  20. DESCRIPTION
  21.  
  22.   Vahunz is a CLI-based replace command that can supersede many words
  23.   across several files with only one invocation.
  24.  
  25.   Normally the target words will be created randomly, turning
  26.   meaningful names into unreadable garbage. For example, a function
  27.   name like read_input_file() could be replaced by g7b() or something
  28.   as useless. Additionally, comments and indention can be removed.
  29.  
  30.   As an option, you can specify certain substitutes, so Vahunz can
  31.   also be applied in a non-destructive manner. This can be used to
  32.   replace inconsistent or unreadable names by something more
  33.   meaningful. Among programmers, this process is known as "The Great
  34.   Renaming".
  35.  
  36. FEATURES
  37.  
  38.   - Stores less/more readable copy in a different directory
  39.   - Supports C, C++ and Java
  40.   - New names since last run are easy to see
  41.   - Names can easily be declared to be modified or left untouched;
  42.     for example, it makes no sense to replace printf().
  43.   - Words being part of comments or string constants are not replaced
  44.   - Fast, as internally names are stored in an AVL-tree
  45.  
  46. NEW FEATURES
  47.  
  48.   - Maintains a second dictionary with names to be ignored
  49.   - Includes some dictionaries with common names to be ignored
  50.   - Supports "The Great Renaming"
  51.   - Added some options to back-trace problems in vahunzed code
  52.   - Several small fixes and improvements
  53.  
  54. SPECIAL REQUIREMENTS
  55.  
  56.   AmigaOS 2.04, 2MB of regular memory, 68020
  57.  
  58. AVAILABILITY
  59.  
  60.   - Every Aminet-mirror, file "dev/misc/vahunz.lha", for example:
  61.  
  62.     ftp://wuarchive.wustl.edu/pub/aminet/dev/misc/vahunz.lha
  63.  
  64.   - http://www.giga.or.at/~agi/vahunz/
  65.  
  66. PRICE
  67.  
  68.   Freeware.
  69.  
  70. DISTRIBUTABILITY
  71.  
  72.   Freely distributable as long the conditions described in the manual
  73.   are met.
  74.  
  75. EXAMPLE
  76.  
  77.   For example,you could have a code excerpt like this:
  78.  
  79.     int main(void)
  80.     {
  81.         while (sepp_age < 83)
  82.         {
  83.             grow_older(sepp_name, &sepp_age);
  84.             print_sepp();
  85.         }
  86.         printf("\n%s died.\n", sepp_name);
  87.         exit(EXIT_SUCCESS);
  88.     }
  89.  
  90.   After vahunzing, this is what it might look like:
  91.  
  92.     int main(void)
  93.     {
  94.     while (g8b < 83)
  95.     {
  96.     z3v(v63, &g8b);
  97.     f_v();
  98.     }
  99.     printf("\n%s died.\n", v63);
  100.     exit(EXIT_SUCCESS);
  101.     }
  102.  
  103.   As you can see, the internal names have been garbled, but the
  104.   symbols of the standard library are preserved.
  105.  
  106.  
  107. ============================= Archive contents =============================
  108.  
  109. Original  Packed Ratio    Date     Time    Name
  110. -------- ------- ----- --------- --------  -------------
  111.   143717   50263 65.0% 20-Feb-98 19:42:54 +amiga.ignore
  112.     5365    2332 56.5% 20-Feb-98 19:42:36 +ansi.ignore
  113.   132716   45805 65.4% 20-Feb-98 19:43:10 +unix.ignore
  114.      204     116 43.1% 09-Feb-98 08:37:14 +Makefile
  115.      367     236 35.6% 09-Feb-98 08:38:44 +older.c
  116.      165     118 28.4% 09-Feb-98 08:34:48 +older.h
  117.      781     413 47.1% 14-Feb-98 20:13:40 +sepp.c
  118.     6070    2505 58.7% 23-Feb-98 00:33:14 +dictionary.html
  119.     3532    1625 53.9% 23-Feb-98 00:32:44 +future.html
  120.      138     138  0.0% 14-Jan-96 17:27:46 +back.gif
  121.      190     190  0.0% 14-Jan-96 17:20:08 +copy.gif
  122.      170     170  0.0% 14-Jan-96 17:14:34 +index.gif
  123.      176     176  0.0% 14-Jan-96 17:14:44 +main.gif
  124.      189     189  0.0% 14-Jan-96 17:15:02 +next.gif
  125.      168     168  0.0% 14-Jan-96 17:28:12 +noback.gif
  126.      211     211  0.0% 14-Jan-96 17:20:36 +nocopy.gif
  127.      200     200  0.0% 14-Jan-96 17:15:28 +noindex.gif
  128.      201     201  0.0% 11-Jan-98 16:39:54 +nomain.gif
  129.      212     212  0.0% 14-Jan-96 17:15:52 +nonext.gif
  130.      213     213  0.0% 15-Jul-96 23:44:28 +noprev.gif
  131.      188     188  0.0% 14-Jan-96 17:16:08 +prev.gif
  132.      141     141  0.0% 04-Nov-95 02:20:36 +up.gif
  133.      981     981  0.0% 21-Feb-98 01:00:48 +vahunz-now.gif
  134.     1545    1545  0.0% 21-Feb-98 01:08:08 +vahunz.gif
  135.     4077    1741 57.2% 23-Feb-98 00:32:26 +index.html
  136.     2745    1314 52.1% 23-Feb-98 00:32:36 +legal.html
  137.     5434    2397 55.8% 23-Feb-98 00:32:34 +overview.html
  138.     3789    1838 51.4% 23-Feb-98 00:32:40 +problems.html
  139.     8967    3504 60.9% 23-Feb-98 00:38:36 +reference.html
  140.     1563     759 51.4% 23-Feb-98 00:32:42 +requirements.html
  141.     2276    1069 53.0% 23-Feb-98 00:32:38 +support.html
  142.    10851    4310 60.2% 23-Feb-98 00:32:32 +tutorial.html
  143.     2056     960 53.3% 23-Feb-98 00:32:46 +use-case-1.html
  144.     4911    2061 58.0% 23-Feb-98 00:32:48 +use-case-2.html
  145.     2912    1347 53.7% 23-Feb-98 00:33:08 +use-case-3.html
  146.     3469    1689 51.3% 23-Feb-98 00:33:10 +use-case-4.html
  147.     3126    1460 53.2% 23-Feb-98 00:33:14 +use-case-5.html
  148.     2734    1255 54.0% 23-Feb-98 00:33:16 +use-case-6.html
  149.    36132   20896 42.1% 23-Feb-98 00:31:28 +vahunz
  150.     2448    1284 47.5% 20-Feb-98 23:19:32 +vahunz.readme
  151. -------- ------- ----- --------- --------
  152.   395330  156220 60.4% 24-Feb-98 01:44:04   40 files
  153.